Список заказов промокодов

Запрос позволяет получить список заказов промокодов.

Синтаксис запроса

GET https://b2b-api.go.yandex.ru/integration/2.0/promocodes/orders/list?
limit=<количество записей> 
&cursor=<отметка от предыдущего запроса>

Заголовки запроса

Authorization: Bearer <OAuth-токен>
Процесс получения токена описан в разделе Начало работы.

X-YaTaxi-Selected-Corp-Client-Id — ID клиента из Личного кабинета. Обязателен, если по токену доступно несколько клиентов.

Параметры запроса

Запрос должен содержать параметр:

limit — количество выводимых записей.

Запрос может содержать необязательныq параметр:

cursor — отметка запроса (возвращается в теле ответа на предыдущий запрос). Для запроса первой страницы параметр указывать не нужно, для запросов последующих страниц — обязательно.

Описание полей ответа

В ответе содержатся поля:

Поле	Описание	Формат
`orders`	Список заказов.	Массив объектов
`next_cursor`	Отметка запроса.	Строка

Структура элементов массива orders:

Поле	Описание	Формат
`active_until`	Дата окончания действия промокода.	Строка
`count`	Количество промокодов в серии.	Число
`order_id`	Идентификатор заказа.	Строка
`pricing`	Подробная информация о цене.	Объект
`service`	Сервис, в котором можно применить промокоды.	Строка
`status`	Статус заказа.	Строка
`value`	Номинал одного промокода.	Число
`revoke_count`	Количество отозванных промокодов в заказе.	Число
`classes`	Список тарифных классов, на которые распространяется промокод в Такси.	Массив
`fuel_types`	Список заправочных типов топлива, на которые распространяется промокод. Указывается только для сервиса «Заправки» (`fuel`). Возможные значения: "a80", "a80_premium", "a92", "a92_premium", "a95", "a95_premium", "a98", "a98_premium", "a100", "a100_premium", "diesel", "diesel_premium", "diesel_winter", "diesel_demiseason", "propane", "metan", "adblue".	Массив

Структура элементов объекта pricing:

Поле	Описание	Формат
`cost`	Стоимость.	Число
`cost_with_vat`	Стоимость с НДС.	Число
`currency`	Валюта.	Строка
`vat`	Значение НДС.	Число

Пример запроса

POST https://b2b-api.go.yandex.ru/integration/2.0/promocodes/orders/list?limit=4
...
Authorization: Bearer <OAuth-token>
X-YaTaxi-Selected-Corp-Client-Id: <client-id>

Пример ответа

{
    "next_cursor": "60e...602",
    "orders": [
        {
            "active_until": "2024-12-01",
            "classes": [
                "cargo"
            ],
            "count": 31,
            "order_id": "15b..7746",
            "pricing": {
                "cost": "6820.00",
                "cost_with_vat": "8184.00",
                "currency": "RUB",
                "vat": "0.20"
            },
            "service": "taxi",
            "status": "creation_success",
            "value": 220,
            "revoke_count": 0
        },
        {
            "active_until": "2024-10-31",
            "count": 12,
            "order_id": "895...48b",
            "pricing": {
                "cost": "1476.00",
                "cost_with_vat": "1771.20",
                "currency": "RUB",
                "vat": "0.20"
            },
            "service": "taxi",
            "status": "creation_success",
            "value": 123,
            "revoke_count": 1
        }
    ]
}

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

200 — запрос выполнен успешно.
400 — запросе был передан неизвестный параметр или параметр с недопустимым значением.
403:
- SELECT_CLIENT_HEADER_REQUIRED — в запросе не передан заголовок X-YaTaxi-Selected-Corp-Client-Id (возвращается в случае, если для токена доступно более одного клиента).
- SELECTED_CLIENT_ACCESS_DENIED — в заголовке X-YaTaxi-Selected-Corp-Client-Id передан ID клиента, к которому нет доступа у этого логина.

Была ли статья полезна?

Отмена заказа промокодов

Список промокодов в заказе